<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* <a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2010 Regents of the University of Colorado.  <a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved. <a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License"); <a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License. <a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at <a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0 <a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software <a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS, <a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and <a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.uimafit.factory;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.ArrayList;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Arrays;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.uima.analysis_engine.AnalysisEngine;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.uima.analysis_engine.AnalysisEngineDescription;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.analysis_engine.metadata.SofaMapping;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.flow.FlowControllerDescription;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.resource.ResourceInitializationException;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.resource.metadata.TypePriorities;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.resource.metadata.TypeSystemDescription;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>    /**<a name="line.32"></a>
<FONT color="green">033</FONT>     * This builder makes it easier to create an aggregate analysis engine. A<a name="line.33"></a>
<FONT color="green">034</FONT>     * typical use-case would involve initializing this builder with your preferred<a name="line.34"></a>
<FONT color="green">035</FONT>     * type system and type priorities (the latter may be null). This is followed by<a name="line.35"></a>
<FONT color="green">036</FONT>     * adding analysis engine descriptions one at a time until done. This makes it<a name="line.36"></a>
<FONT color="green">037</FONT>     * easy to have runtime decisions determine how the aggregate engine should be<a name="line.37"></a>
<FONT color="green">038</FONT>     * built. Finally, one of the create methods are called and an AnalysisEngine or<a name="line.38"></a>
<FONT color="green">039</FONT>     * AnalysisEngineDescription is returned.<a name="line.39"></a>
<FONT color="green">040</FONT>     * <a name="line.40"></a>
<FONT color="green">041</FONT>     * @author Philip Ogren<a name="line.41"></a>
<FONT color="green">042</FONT>     */<a name="line.42"></a>
<FONT color="green">043</FONT>    public class AggregateBuilder {<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>            List&lt;String&gt; componentNames = new ArrayList&lt;String&gt;();<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>            List&lt;SofaMapping&gt; sofaMappings = new ArrayList&lt;SofaMapping&gt;();<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>            List&lt;AnalysisEngineDescription&gt; analysisEngineDescriptions = new ArrayList&lt;AnalysisEngineDescription&gt;();<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>            TypeSystemDescription typeSystemDescription;<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>            TypePriorities typePriorities;<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>             FlowControllerDescription flowControllerDescription;<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>            /**<a name="line.57"></a>
<FONT color="green">058</FONT>             * The default no-args constructor calls {@link AggregateBuilder#AggregateBuilder(TypeSystemDescription, TypePriorities, FlowControllerDescription)} <a name="line.58"></a>
<FONT color="green">059</FONT>             * with null-valued args.<a name="line.59"></a>
<FONT color="green">060</FONT>             */<a name="line.60"></a>
<FONT color="green">061</FONT>            public AggregateBuilder() {<a name="line.61"></a>
<FONT color="green">062</FONT>                    this(null, null, null);<a name="line.62"></a>
<FONT color="green">063</FONT>            }<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>            /**<a name="line.65"></a>
<FONT color="green">066</FONT>             * Instantiate an AggregateBuilder with a given type system, type priorities, and flow controller.  Generally, speaking <a name="line.66"></a>
<FONT color="green">067</FONT>             * it suffices to use the no arguments constructor<a name="line.67"></a>
<FONT color="green">068</FONT>             * @param typeSystemDescription this can be instantiated using {@link TypeSystemDescriptionFactory}<a name="line.68"></a>
<FONT color="green">069</FONT>             * @param typePriorities this can be instantiated using {@link TypePrioritiesFactory}<a name="line.69"></a>
<FONT color="green">070</FONT>             * @param flowControllerDescription this can be instantiated using {@link FlowControllerFactory}<a name="line.70"></a>
<FONT color="green">071</FONT>             */<a name="line.71"></a>
<FONT color="green">072</FONT>            public AggregateBuilder(TypeSystemDescription typeSystemDescription, TypePriorities typePriorities,<a name="line.72"></a>
<FONT color="green">073</FONT>                             FlowControllerDescription flowControllerDescription) {<a name="line.73"></a>
<FONT color="green">074</FONT>                    this.typeSystemDescription = typeSystemDescription;<a name="line.74"></a>
<FONT color="green">075</FONT>                    this.typePriorities = typePriorities;<a name="line.75"></a>
<FONT color="green">076</FONT>                    this.flowControllerDescription = flowControllerDescription;<a name="line.76"></a>
<FONT color="green">077</FONT>            }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>            /**<a name="line.79"></a>
<FONT color="green">080</FONT>             * This method simply calls<a name="line.80"></a>
<FONT color="green">081</FONT>             * {@link #add(String, AnalysisEngineDescription, String...)} using the<a name="line.81"></a>
<FONT color="green">082</FONT>             * result of<a name="line.82"></a>
<FONT color="green">083</FONT>             * {@link AnalysisEngineDescription#getAnnotatorImplementationName()} for<a name="line.83"></a>
<FONT color="green">084</FONT>             * the component name<a name="line.84"></a>
<FONT color="green">085</FONT>             * <a name="line.85"></a>
<FONT color="green">086</FONT>             * @param aed<a name="line.86"></a>
<FONT color="green">087</FONT>             * @param viewNames<a name="line.87"></a>
<FONT color="green">088</FONT>             * @return the name of the component generated for the {@link AnalysisEngineDescription}<a name="line.88"></a>
<FONT color="green">089</FONT>             */<a name="line.89"></a>
<FONT color="green">090</FONT>            public String add(AnalysisEngineDescription aed, String... viewNames) {<a name="line.90"></a>
<FONT color="green">091</FONT>                    String componentName = aed.getAnalysisEngineMetaData().getName();<a name="line.91"></a>
<FONT color="green">092</FONT>                    if (componentName == null || componentName.equals("")) {<a name="line.92"></a>
<FONT color="green">093</FONT>                            if (aed.isPrimitive()) {<a name="line.93"></a>
<FONT color="green">094</FONT>                                    componentName = aed.getAnnotatorImplementationName();<a name="line.94"></a>
<FONT color="green">095</FONT>                            }<a name="line.95"></a>
<FONT color="green">096</FONT>                            else {<a name="line.96"></a>
<FONT color="green">097</FONT>                                    componentName = "aggregate";<a name="line.97"></a>
<FONT color="green">098</FONT>                            }<a name="line.98"></a>
<FONT color="green">099</FONT>                    }<a name="line.99"></a>
<FONT color="green">100</FONT>                    if (componentNames.contains(componentName)) {<a name="line.100"></a>
<FONT color="green">101</FONT>                            componentName = componentName + "." + (componentNames.size() + 1);<a name="line.101"></a>
<FONT color="green">102</FONT>                    }<a name="line.102"></a>
<FONT color="green">103</FONT>                    add(componentName, aed, viewNames);<a name="line.103"></a>
<FONT color="green">104</FONT>                    return componentName;<a name="line.104"></a>
<FONT color="green">105</FONT>            }<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>            /**<a name="line.107"></a>
<FONT color="green">108</FONT>             * @param componentName<a name="line.108"></a>
<FONT color="green">109</FONT>             *            - the name of the component to add<a name="line.109"></a>
<FONT color="green">110</FONT>             * @param aed<a name="line.110"></a>
<FONT color="green">111</FONT>             *            - an analysis engine description to add to the aggregate<a name="line.111"></a>
<FONT color="green">112</FONT>             *            analysis engine<a name="line.112"></a>
<FONT color="green">113</FONT>             * @param viewNames<a name="line.113"></a>
<FONT color="green">114</FONT>             *            - pairs of view names corresponding to a componentSofaName<a name="line.114"></a>
<FONT color="green">115</FONT>             *            followed by the aggregateSofaName that it is mapped to. An<a name="line.115"></a>
<FONT color="green">116</FONT>             *            even number of names must be passed in or else an<a name="line.116"></a>
<FONT color="green">117</FONT>             *            IllegalArgumentException will be thrown. See<a name="line.117"></a>
<FONT color="green">118</FONT>             *            {@link SofaMappingFactory#createSofaMapping(String, String, String)}<a name="line.118"></a>
<FONT color="green">119</FONT>             */<a name="line.119"></a>
<FONT color="green">120</FONT>            public void add(String componentName, AnalysisEngineDescription aed, String... viewNames) {<a name="line.120"></a>
<FONT color="green">121</FONT>                    if (componentNames.contains(componentName)) {<a name="line.121"></a>
<FONT color="green">122</FONT>                            throw new IllegalArgumentException("the component name '" + componentName<a name="line.122"></a>
<FONT color="green">123</FONT>                                            + "' has already been used for another added analysis engine description.");<a name="line.123"></a>
<FONT color="green">124</FONT>                    }<a name="line.124"></a>
<FONT color="green">125</FONT>                    if (viewNames != null &amp;&amp; viewNames.length % 2 != 0) {<a name="line.125"></a>
<FONT color="green">126</FONT>                            throw new IllegalArgumentException(<a name="line.126"></a>
<FONT color="green">127</FONT>                                            "an even number of view names is required (as component view name, aggregate view name pairs) for the AggregateBuilder.add method.  "<a name="line.127"></a>
<FONT color="green">128</FONT>                                                            + viewNames.length + " view names passed: " + Arrays.asList(viewNames));<a name="line.128"></a>
<FONT color="green">129</FONT>                    }<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>                    analysisEngineDescriptions.add(aed);<a name="line.131"></a>
<FONT color="green">132</FONT>                    componentNames.add(componentName);<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>                    if (viewNames != null) {<a name="line.134"></a>
<FONT color="green">135</FONT>                            for (int i = 0; i &lt; viewNames.length; i += 2) {<a name="line.135"></a>
<FONT color="green">136</FONT>                                    sofaMappings.add(SofaMappingFactory.createSofaMapping(componentName, viewNames[i], viewNames[i + 1]));<a name="line.136"></a>
<FONT color="green">137</FONT>                            }<a name="line.137"></a>
<FONT color="green">138</FONT>                    }<a name="line.138"></a>
<FONT color="green">139</FONT>            }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>            /**<a name="line.141"></a>
<FONT color="green">142</FONT>             * Provide a sofa mapping for a component from the component's view to the aggregate view.<a name="line.142"></a>
<FONT color="green">143</FONT>             * @param componentName the name of the component<a name="line.143"></a>
<FONT color="green">144</FONT>             * @param componentViewName the name of the component view<a name="line.144"></a>
<FONT color="green">145</FONT>             * @param aggregateViewName the name of the aggregate view to map the component view to.<a name="line.145"></a>
<FONT color="green">146</FONT>             */<a name="line.146"></a>
<FONT color="green">147</FONT>            public void addSofaMapping(String componentName, String componentViewName, String aggregateViewName) {<a name="line.147"></a>
<FONT color="green">148</FONT>                    if (componentNames.contains(componentName)) {<a name="line.148"></a>
<FONT color="green">149</FONT>                            sofaMappings.add(SofaMappingFactory.createSofaMapping(componentName, componentViewName, aggregateViewName));<a name="line.149"></a>
<FONT color="green">150</FONT>                    }<a name="line.150"></a>
<FONT color="green">151</FONT>                    else {<a name="line.151"></a>
<FONT color="green">152</FONT>                            throw new IllegalArgumentException("No component with the name '" + componentName<a name="line.152"></a>
<FONT color="green">153</FONT>                                            + "' has been added to this builder.  Sofa mappings may only be added for components that have been added to this builder. ");<a name="line.153"></a>
<FONT color="green">154</FONT>                    }<a name="line.154"></a>
<FONT color="green">155</FONT>            }<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>            /**<a name="line.157"></a>
<FONT color="green">158</FONT>             * Set the flow controller description of the aggregate engine created by this builder.<a name="line.158"></a>
<FONT color="green">159</FONT>             * @param flowControllerDescription see {@link FlowControllerFactory}<a name="line.159"></a>
<FONT color="green">160</FONT>             */<a name="line.160"></a>
<FONT color="green">161</FONT>            public void setFlowControllerDescription( FlowControllerDescription flowControllerDescription) {<a name="line.161"></a>
<FONT color="green">162</FONT>                    this.flowControllerDescription = flowControllerDescription;<a name="line.162"></a>
<FONT color="green">163</FONT>            }<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>            /**<a name="line.165"></a>
<FONT color="green">166</FONT>             * This method simply delegates to<a name="line.166"></a>
<FONT color="green">167</FONT>             * {@link AnalysisEngineFactory#createAggregate(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)}<a name="line.167"></a>
<FONT color="green">168</FONT>             * with the data collected by this builder.<a name="line.168"></a>
<FONT color="green">169</FONT>             * <a name="line.169"></a>
<FONT color="green">170</FONT>             * @return an aggregate analysis engine<a name="line.170"></a>
<FONT color="green">171</FONT>             * @throws ResourceInitializationException<a name="line.171"></a>
<FONT color="green">172</FONT>             */<a name="line.172"></a>
<FONT color="green">173</FONT>            public AnalysisEngine createAggregate() throws ResourceInitializationException {<a name="line.173"></a>
<FONT color="green">174</FONT>                    return AnalysisEngineFactory.createAggregate(analysisEngineDescriptions, componentNames, typeSystemDescription,<a name="line.174"></a>
<FONT color="green">175</FONT>                                    typePriorities, sofaMappings.toArray(new SofaMapping[sofaMappings.size()]),  flowControllerDescription);<a name="line.175"></a>
<FONT color="green">176</FONT>            }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>            /**<a name="line.178"></a>
<FONT color="green">179</FONT>             * This method simply delegates to<a name="line.179"></a>
<FONT color="green">180</FONT>             * {@link AnalysisEngineFactory#createAggregateDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)}<a name="line.180"></a>
<FONT color="green">181</FONT>             * with the data collected by this builder.<a name="line.181"></a>
<FONT color="green">182</FONT>             * <a name="line.182"></a>
<FONT color="green">183</FONT>             * @return a description of an aggregate analysis engine<a name="line.183"></a>
<FONT color="green">184</FONT>             * @throws ResourceInitializationException<a name="line.184"></a>
<FONT color="green">185</FONT>             */<a name="line.185"></a>
<FONT color="green">186</FONT>            public AnalysisEngineDescription createAggregateDescription() throws ResourceInitializationException {<a name="line.186"></a>
<FONT color="green">187</FONT>                    return AnalysisEngineFactory.createAggregateDescription(analysisEngineDescriptions, componentNames,<a name="line.187"></a>
<FONT color="green">188</FONT>                                    typeSystemDescription, typePriorities, sofaMappings.toArray(new SofaMapping[sofaMappings.size()]), flowControllerDescription);<a name="line.188"></a>
<FONT color="green">189</FONT>            }<a name="line.189"></a>
<FONT color="green">190</FONT>    <a name="line.190"></a>
<FONT color="green">191</FONT>    }<a name="line.191"></a>




























































</PRE>
</BODY>
</HTML>
